Rename ephemeral_storage to disk for simplicity #3095
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. Support `ephemeral_storage` as an alias for backward compatibility
and developer-facing code
2. Encourage users to switch to `disk` when configuring this property
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run Status
|
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run Status
|
Signed-off-by: JiangJiaWei1103 <[email protected]>
`|` is supported for 3.10+, please see PEP 604. Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run Status
|
JiangJiaWei1103
requested review from
wild-endeavor,
kumare3,
eapolinario,
pingsutw,
cosmicBboy,
samhita-alla,
thomasjpfan and
Future-Outlier
as code owners
JiangJiaWei1103
changed the title
Code Review Agent Run #c7015eActionable Suggestions - 3
Review Details
AI Code Review powered by |
Changelist by BitoThis pull request implements the following key changes.
|
flyte-bot
reviewed
Feb 9, 2025
| # This allocates 1Gi of such local storage. | ||
| Resources(ephemeral_storage="1Gi") | ||
| Resources(disk="1Gi") |
There was a problem hiding this comment.
Consider maintaining backward compatibility for parameters
Consider maintaining backward compatibility by keeping both disk and ephemeral_storage parameters functional. While renaming to disk improves clarity, some existing code may still use ephemeral_storage. Consider handling both parameters and adding a deprecation warning for ephemeral_storage.
Code suggestion
Check the AI-generated fix before applying
- disk: InitVar[Optional[Union[str, int]]] = None
- ephemeral_storage: Optional[Union[str, int]] = None
+ disk: Optional[Union[str, int]] = None
+ ephemeral_storage: InitVar[Optional[Union[str, int]]] = None
def __post_init__(self, disk):
+ if disk is not None:
+ self.disk = disk
+ if self.ephemeral_storage is not None:
+ warnings.warn('The ephemeral_storage parameter is deprecated. Please use disk instead.', DeprecationWarning)
+ if self.disk is None:
+ self.disk = self.ephemeral_storage
Code Review Run #c7015e
Is this a valid issue, or was it incorrectly flagged by the Agent?
- it was incorrectly flagged
flyte-bot
reviewed
Feb 9, 2025
| @@ -33,9 +35,10 @@ class Resources(DataClassJSONMixin): | |||
| cpu: Optional[Union[str, int, float]] = None | |||
| mem: Optional[Union[str, int]] = None | |||
| gpu: Optional[Union[str, int]] = None | |||
| disk: InitVar[Optional[Union[str, int]]] = None | |||
There was a problem hiding this comment.
Consider consistent type annotation for resources
Consider using a consistent type annotation pattern for resource fields. While disk is marked as InitVar, other similar resource fields (cpu, mem, gpu, ephemeral_storage) are not. This inconsistency might lead to confusion in how these fields are processed.
Code suggestion
Check the AI-generated fix before applying
- cpu: Optional[Union[str, int, float]] = None
- mem: Optional[Union[str, int]] = None
- gpu: Optional[Union[str, int]] = None
- disk: InitVar[Optional[Union[str, int]]] = None
- ephemeral_storage: Optional[Union[str, int]] = None
+ cpu: InitVar[Optional[Union[str, int, float]]] = None
+ mem: InitVar[Optional[Union[str, int]]] = None
+ gpu: InitVar[Optional[Union[str, int]]] = None
+ disk: InitVar[Optional[Union[str, int]]] = None
+ ephemeral_storage: InitVar[Optional[Union[str, int]]] = None
Code Review Run #c7015e
Is this a valid issue, or was it incorrectly flagged by the Agent?
- it was incorrectly flagged
flyte-bot
reviewed
Feb 9, 2025
| # Specify only disk | ||
| resources = Resources(cpu="1", mem="1Gi", gpu="1", disk="1Gi") | ||
| assert resources.disk == "1Gi" | ||
| assert resources.ephemeral_storage == "1Gi" |
There was a problem hiding this comment.
Consider removing redundant test assertions
Consider removing redundant assertions since disk and ephemeral_storage are expected to have the same value. A single assertion would be sufficient to verify the behavior.
Code suggestion
Check the AI-generated fix before applying
Suggested change
| assert resources.ephemeral_storage == "1Gi" |
Code Review Run #c7015e
Is this a valid issue, or was it incorrectly flagged by the Agent?
- it was incorrectly flagged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tracking issue
Closes flyteorg/flyte#6142.
Why are the changes needed?
The attribute
ephemeral_storageofResources(i.e., K8s pod resources) is too complicated and should be simplified.What changes were proposed in this pull request?
At this stage, we propose to support both
diskandephemeral_storagefor backward compatibility.The behavior of different configurations is summarized as follows:
diskandephemeral_storageare specified: Raise an errorephemeral_storageis used: Warn users about the future deprecationdiskis used: Usediskdirectly and allowephemeral_storageto mirrordiskvalueHow was this patch tested?
Setup process
Screenshots
Check all the applicable boxes
Related PRs
Docs link
Summary by Bito
This PR renames 'ephemeral_storage' to 'disk' in the Resources class while maintaining backward compatibility through deprecation warnings. The implementation allows both attributes to function, with 'ephemeral_storage' mirroring the 'disk' value. The changes include comprehensive test coverage and improved parameter handling for better code clarity.Unit tests added: True
Estimated effort to review (1-5, lower is better): 1